Management API
Base Resource URL:
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles
Description:
Represents Provider Profiles available to this merchant. Not all profiles might be configured and of all configured, only part might be active. Inactive profiles are not used for processing.
Available sub-resources:
| Resource URL | Description |
|---|---|
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/3d-secure | Represents Provider Profiles that define settings necessary for 3D Secure authorization through MPI. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/account-updater | Represents Provider Profiles that define settings necessary to perform debit and credit card account updates (updated numbers, expiration dates, etc). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/account-verification | Represents Provider Profiles that define settings necessary for account verification processing. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/ach | Represents Provider Profiles that define settings necessary to process bank account transfers (ACH transactions).
Note: since true real-time ACH transactions are not possible, no separate settings are maintained for batch and real-time processing. While real-time processing logic is emulated, it uses batch configuration as basis for its implementation. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/ach-realtime | Represents Provider Profiles that define settings necessary to process bank account transfers (ACH real-time transactions). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/amex-account-updater | Represents Provider Profiles that define settings necessary for account updater processing through Amex. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/amex-batch | Represents Provider Profiles that define settings necessary to process Amex cards in batch (file based). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/amex-chargeback | Represents Provider Profiles that define settings necessary for chargeback processing through Amex. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/amex-realtime | Represents Provider Profiles that define settings necessary to process Amex cards in real-time (single transaction at a time). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/cards-batch | Represents Provider Profiles that define settings necessary to process debit and credit cards in batch mode (file based). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/cards-realtime | Represents Provider Profiles that define settings necessary to process debit and credit cards in real-time (single transaction at a time). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/chargeback | Represents Provider Profiles that define settings necessary for chargeback processing. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/credit-reporting | Represents Provider Profiles that define settings necessary to report debt to credit bureaus. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/email | Represents Provider Profiles that define settings necessary to send email notifications. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/fraud | Represents Provider Profiles that define settings necessary for fraud protection definition. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/fraud/sedra | Configuration settings necessary for fraud/sedra. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/fraud/subuno | Represents Provider Profiles that define settings necessary for fraud protection through Subuno. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/gift-realtime | Represents Provider Profiles that define settings necessary to process Gift and Loyalty cards in real-time (single transaction at a time). |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/letter | Represents Provider Profiles that define settings necessary to communication with print houses to coordinating sending of the printed mail. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/phone-call | Represents Provider Profiles that define settings for communication and data submission to automated calling services. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/processing-cost | Represents Provider Profiles that define settings necessary for processing cost definition. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/reconciliation | Represents Provider Profiles that define settings necessary for reconciliation definition. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/skip-tracing | Represents Provider Profiles that define settings necessary for skip-tracing processing. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/sms | Represents Provider Profiles that define settings necessary for sms processing through Front Gateway. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/tokenization | Represents Provider Profiles that define settings necessary for account numbers tokenization. |
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/profiles/wallet |
Supported Actions:
configure
Parameters:
find
Parameters:
| Method: GET | Implicit: No | Returns: ServiceResponse[] |
| Consumes: xurl | Produces: json, xml | |
|
Configures Provider Profiles in accordance to a selected configuration profile.
All configuration profiles are stored in $app-home/resources/configurations. |
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | profile | String | Yes |
Name of the configuration file to be used for Provider Profile configuration. |
find
| Method: GET | Implicit: Yes | Returns: n/a |
| Consumes: xurl | Produces: json, xml | |
|
Lists all Provider Profiles currently configured for this merchant.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | offset | Integer | No | 0 |
Index of the first record returned to the customer from the search result of a web search. |
| 02 | limit | Integer | No | 100 |
Maximum number of records to load per single search web call made by the customer. |
Copyright ©
TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.